\" Define project URL
.ds lcovurl https://github.com/linux\-test\-project/lcov

.TH lcov 1 "LCOV 2.0" 2023\-05\-17 "User Manuals"
.SH NAME
lcov \- a graphical GCOV front\-end
.SH SYNOPSIS

Capture coverage data tracefile (from compiler-generated data):
.br

.RS 3
.B lcov
.BR \-c | \-\-capture
.RS 4
.br
.RB [ \-d | \-\-directory
.IR directory ]
.RB [ \-k | \-\-kernel\-directory
.IR directory ]
.br
.RB [ \-o | \-\-output\-file
.IR tracefile ]
.RB [ \-t | \-\-test\-name
.IR testname ]
.br
.RB [ \-b | \-\-base\-directory
.IR directory ]
.br
.RB [ \-\-build\-directory
.IR directory ]
.br
.RB [ \-\-source\-directory
.IR directory ]
.br
.RB [ \-i | \-\-initial ]
.br
.RB [ \-\-all ] ]
.br
.RB [ \-\-gcov\-tool
.IR tool ]
.br
.RB [ \-\-branch\-coverage ]
.br
.RB [ \-\-demangle\-cpp
.IR [ param ] ]
.br
.RB [ \-\-checksum ]
.RB [ \-\-no\-checksum ]
.RB [ \-\-no\-recursion ]
.RB [ \-f | \-\-follow ]
.br
.RB [ \-\-compat\-libtool ]
.RB [ \-\-no\-compat\-libtool ]
.br
.RB [ \-\-ignore\-errors
.IR errors ]
.br
.RB [ \-\-preserve ]
.RB [ \-\-to\-package
.IR package ]
.RB [ \-\-from\-package
.IR package ]
.RB [ \-\-no\-markers ]
.RB [ \-\-external ]
.RB [ \-\-no\-external ]
.br
.RB [ \-\-compat
.IR  mode =on|off|auto]
.br
.RB [ \-\-version\-script
.IR script_file ]
.br
.RB [ \-\-resolv-\-script
.IR script_file ]
.br
.RB [ \-\-comment
.IR comment_string ]
.br
.RE
.RE

Generate tracefile (from compiler-generated data) with all counter values set to zero:
.br

.RS 3
.B lcov
.BR \-z | \-\-zerocounters
.RS 4
.br
.RB [ \-d | \-\-directory
.IR directory ]
.RB [ \-\-no\-recursion ]
.RB [ \-f | \-\-follow ]
.br
.RE
.RE

Show coverage counts recorded in previously generated tracefile:
.br

.RS 3
.B lcov
.BR \-l | \-\-list
.I tracefile
.RS 4
.br
.RB [ \-\-list\-full\-path ]
.RB [ \-\-no\-list\-full\-path ]
.br
.RE
.RE

Aggregate multiple coverage tracefiles into one:
.br

.RS 3
.B lcov
.BR \-a | \-\-add\-tracefile
.I tracefile_pattern
.RS 4
.br
.RB [ \-o | \-\-output\-file
.IR tracefile ]
.br
.RB [ \-\-prune\-tests ]
.br
.RB [ \-\-forget\-test\-names ]
.br
.RB [ \-\-map\-functions ]
.br
.RB [ \-\-branch\-coverage ]
.br
.RB [ \-\-checksum ]
.RB [ \-\-no\-checksum ]
.br
.RE

Depending on your use model, it may not be necessary to create aggregate coverage data files.
For example, if your regression tests are split into multiple suites, you may want to keep separate suite data and to compare both per-suite and aggregate results over time.
.B genhtml
allows you specify tracefiles via one or more glob patterns - which enables you
generate aggregate reports without explicitly generating aggregated trace files.
See the
.B genhtml
man page.
.RE


Generate new tracefile from existing tracefile, keeping only data from files matching pattern:
.br

.RS 3
.B lcov
.BR \-e | \-\-extract
.I tracefile pattern
.RS 4
.br
.RB [ \-o | \-\-output\-file
.IR tracefile ]
.RB [ \-\-checksum ]
.RB [ \-\-no\-checksum ]
.br
.RE
.RE

Generate new tracefile from existing tracefile, removing data from files matching pattern:
.br

.RS 3
.B lcov
.BR \-r | \-\-remove
.I tracefile pattern
.RS 4
.br
.RB [ \-o | \-\-output\-file
.IR tracefile ]
.RB [ \-\-checksum ]
.RB [ \-\-no\-checksum ]
.br
.RE
.RE

Generate new tracefile from existing tracefiles by performing set operations on coverage data:
.br

.RS 3
.B lcov
.BR \-\-intersect
.I rh_glob_pattern
.RS 4
.br
.RB [ \-o | \-\-output\-file
.IR tracefile ]
.br
lh_glob_pattern


The output will reflect
.RS 2
.I (union of files matching lh_glob_patterns)
.I intersect
.I (union of files matching rh_glob_patterns)
.RE
such that coverpoints found in both sets are merged (summed) whereas coverpoints found in only one set are dropped.
Note that branch blocks are defined to be the same if and only if their block ID and the associated branch expressions list are identical.
Functions are defined to be the same if their name and location are identical.
.RE
.RE

.RS 3
.B lcov
.BR \-\-subtract
.I rh_glob_pattern
.RS 4
.br
.RB [ \-o | \-\-output\-file
.IR tracefile ]
.br
lh_glob_pattern

The output will reflect
.RS 2
.I (union of files matching lh_glob_patterns)
.I subtract
.I (union of files matching rh_glob_patterns)
.RE
such that coverpoints found only in the set on the left will be retained and all others are dropped.
.RE

.RE


Generate new tracefile from existing tracefile, modifying line numbers as indicated in diff file:
.br

.RS 3
.B lcov
.BR \-\-diff
.IR "tracefile diff"
.RS 4
.br
.RB [ \-o | \-\-output\-file
.IR tracefile ]
.RB [ \-\-checksum ]
.RB [ \-\-no\-checksum ]
.br
.RB [ \-\-convert\-filenames ]
.RB [ \-\-strip
.IR depth ]
.RB [ \-\-path
.IR path ]
.br
.RE
.RE


Summarize tracefile content:
.br

.RS 3
.B lcov
.BR \-\-summary
.I tracefile
.RS 4
.br
.RB [ \-\-fail-under-lines
.IR percentage ]
.br
.RE
.RE

Print version or help message and exit:
.br

.RS 3
.B lcov
.RB [ \-h | \-\-help ]
.RB [ \-\-version ]
.RE

Common lcov options - supported by all the above use cases:
.br

.RS 3
.B lcov
.RB [ \-\-keep\-going ]
.br
.RS 5
.RB [ \-\-filter
.IR type  ]
.br
.br
.RB [ \-q | \-\-quiet ]
.br
.RB [ \-v | \-\-verbose ]
.br
.RB [ \-\-comment
.IR comment_string ]
.br
.RB [ \-\-debug ]
.br
.RB [ \-\-parallel | -j
.IR [integer] ]
.br
.RB [ \-\-memory
.IR integer_num_Mb ]
.br
.RB [ \-\-tempdir
.IR dirname ]
.br
.RB [ \-\-branch\-coverage ]
.br
.RB [ \-\-config\-file
.IR config\-file ]
.RB [ \-\-rc
.IR keyword = value ]
.br
.RB [ \-\-include
.IR glob_pattern ]
.br
.RB [ \-\-exclude
.IR glob_pattern ]
.br
.RB [ \-\-erase\-functions
.IR regexp_pattern ]
.br
.RB [ \-\-substitute
.IR regexp_pattern ]
.br
.RB [ \-\-omit\-lines
.IR regexp_pattern ]
.br
.RE
.RE

.SH DESCRIPTION
.B lcov
is a graphical front\-end for GCC's coverage testing tool gcov. It collects
line, function and branch coverage data for multiple source files and creates
HTML pages containing the source code annotated with coverage information.
It also adds overview pages for easy navigation within the file structure.

Use
.B lcov
to collect coverage data and
.B genhtml
to create HTML pages. Coverage data can either be collected from the
currently running Linux kernel or from a user space application. To do this,
you have to complete the following preparation steps:

For Linux kernel coverage:
.RS
Follow the setup instructions for the gcov\-kernel infrastructure:
.I https://docs.kernel.org/dev-tools/gcov.html
.br
.RE

For user space application coverage:
.RS 3
Compile the application with GCC using the options
"\-fprofile\-arcs" and "\-ftest\-coverage" or "\-\-coverage".
.RE

Please note that this man page refers to the output format of
.B lcov
as ".info file" or "tracefile" and that the output of GCOV
is called ".da file".

Also note that when printing percentages, 0% and 100% are only printed when
the values are exactly 0% and 100% respectively. Other values which would
conventionally be rounded to 0% or 100% are instead printed as nearest
non-boundary value. This behavior is in accordance with that of the
.BR gcov (1)
tool.

By default,
.B lcov
and related tools generate and collect line and function coverage data.
Branch data is not collected or displayed by default; all tools support the
.B --branch-coverage
option to enable branch coverage - or you can permanently enable branch coverage by adding the appropriate
settings to your personal, group, or site lcov configuration file.  See man
.B lcovrc(5)
for details.

.SH OPTIONS


.B \-a
.I tracefile_pattern
.br
.B \-\-add\-tracefile
.I tracefile_pattern
.br
.RS
Add contents of all files matching glob pattern
.IR tracefile_pattern.

Specify several tracefiles using the \-a switch to combine the coverage data
contained in these files by adding up execution counts for matching test and
filename combinations.

The result of the add operation will be written to stdout or the tracefile
specified with \-o.

Only one of  \-z, \-c, \-a, \-e, \-r, \-l, \-\-diff or \-\-summary may be
specified at a time.

.RE

.B \-b
.I directory
.br
.B \-\-base\-directory
.I directory
.br
.RS
.RI "Use " directory
as base directory for relative paths.

Use this option to specify the base directory of a build\-environment
when lcov produces error messages like:

.RS
ERROR: could not read source file /home/user/project/subdir1/subdir2/subdir1/subdir2/file.c
.RE

In this example, use /home/user/project as base directory.

This option is required when using lcov on projects built with libtool or
similar build environments that work with a base directory, i.e. environments,
where the current working directory when invoking the compiler is not the same
directory in which the source code file is located.

Note that this option will not work in environments where multiple base
directories are used. In that case use configuration file setting
.B geninfo_auto_base=1
(see man
.BR lcovrc (5)
).

.RE

.B \-\-build\-directory
.I build_directory
.br
.RS
search for .gcno data files from build_directory rather than
adjacent to the corresponding .gcda file.

See man
.BR geninfo (1))
for details.


.RE
.BI "\-\-source\-directory " dirname
.RS
Add 'dirname' to the list of places to look for source files.
.br

For relative source file paths listed in
.I e.g.
paths found in
.IR tracefile,
or found in gcov output during
.I \-\-capture
\- possibly after substitutions have been applied -
.B lcov
 will first look for the path from 'cwd' (where genhtml was
invoked) and
then from each alternate directory name in the order specified.
The first location matching location is used.

This option can be specified multiple times, to add more directories to the source search path.


.RE
.B \-c
.br
.B \-\-capture
.br
.RS
Capture runtime coverage data.

By default captures the current kernel execution counts and writes the
resulting coverage data to the standard output. Use the \-\-directory
option to capture counts for a user space program.

The result of the capture operation will be written to stdout or the tracefile
specified with \-o.

When combined with the
.BR \-\-all
flag, both runtime and compile-time coverage will be extracted in one step.
See the description of the
.BR \-\-initial
flag, below.

See man
.BR geninfo (1))
for more details about the capture process and available options and parameters.


Only one of  \-z, \-c, \-a, \-e, \-r, \-l, \-\-diff or \-\-summary may be
specified at a time.
.RE

.B \-\-branch\-coverage
.RS
.br
Collect and/or retain branch coverage data.

This is equivalent to using the option "\-\-rc branch_coverage=1"; the option was added to better match the genhml interface.

.RE

.B \-\-checksum
.br
.B \-\-no\-checksum
.br
.RS
Specify whether to generate checksum data when writing tracefiles and/or to
verify matching checksums when combining trace files.

Use \-\-checksum to enable checksum generation or \-\-no\-checksum to
disable it. Checksum generation is
.B disabled
by default.

When checksum generation is enabled, a checksum will be generated for each
source code line and stored along with the coverage data. This checksum will
be used to prevent attempts to combine coverage data from different source
code versions.

If you don't work with different source code versions, disable this option
to speed up coverage data processing and to reduce the size of tracefiles.

Note that this options is somewhat subsumed by the
.B \-\-version\-script
option - which does something similar, but at the 'whole file' level.
.RE

.B \-\-compat
.IR mode = value [, mode = value ,...]
.br
.RS
Set compatibility mode.

Use \-\-compat to specify that lcov should enable one or more compatibility
modes when capturing coverage data. You can provide a comma-separated list
of mode=value pairs to specify the values for multiple modes.

Valid
.I values
are:

.B on
.RS
Enable compatibility mode.
.RE
.B off
.RS
Disable compatibility mode.
.RE
.B auto
.RS
Apply auto-detection to determine if compatibility mode is required. Note that
auto-detection is not available for all compatibility modes.
.RE

If no value is specified, 'on' is assumed as default value.

Valid
.I modes
are:

.B libtool
.RS
Enable this mode if you are capturing coverage data for a project that
was built using the libtool mechanism. See also
\-\-compat\-libtool.

The default value for this setting is 'on'.

.RE
.B hammer
.RS
Enable this mode if you are capturing coverage data for a project that
was built using a version of GCC 3.3 that contains a modification
(hammer patch) of later GCC versions. You can identify a modified GCC 3.3
by checking the build directory of your project for files ending in the
extension '.bbg'. Unmodified versions of GCC 3.3 name these files '.bb'.

The default value for this setting is 'auto'.

.RE
.B split_crc
.RS
Enable this mode if you are capturing coverage data for a project that
was built using a version of GCC 4.6 that contains a modification
(split function checksums) of later GCC versions. Typical error messages
when running lcov on coverage data produced by such GCC versions are
\'out of memory' and 'reached unexpected end of file'.

The default value for this setting is 'auto'
.RE

.RE

.B \-\-compat\-libtool
.br
.B \-\-no\-compat\-libtool
.br
.RS
Specify whether to enable libtool compatibility mode.

Use \-\-compat\-libtool to enable libtool compatibility mode or \-\-no\-compat\-libtool
to disable it. The libtool compatibility mode is
.B enabled
by default.

When libtool compatibility mode is enabled, lcov will assume that the source
code relating to a .da file located in a directory named ".libs" can be
found in its parent directory.

If you have directories named ".libs" in your build environment but don't use
libtool, disable this option to prevent problems when capturing coverage data.
.RE

.B \-\-config\-file
.I config\-file
.br
.RS
Specify a configuration file to use.
See man
.B lcovrc(5)
for details of the file format and options.

When this option is specified, neither the system\-wide configuration file
/etc/lcovrc, nor the per\-user configuration file ~/.lcovrc is read.

This option may be useful when there is a need to run several
instances of
.B lcov
with different configuration file options in parallel.

Note that this option must be specified in full - abbreviations are not supported.

.RE

.B \-\-convert\-filenames
.br
.RS
Convert filenames when applying diff.

Use this option together with \-\-diff to rename the file names of processed
data sets according to the data provided by the diff.
.RE

.B \-\-diff
.I tracefile
.I difffile
.br
.RS
Convert coverage data in
.I tracefile
using source code diff file
.IR difffile .

Use this option if you want to merge coverage data from different source code
levels of a program, e.g. when you have data taken from an older version
and want to combine it with data from a more current version.
.B lcov
will try to map source code lines between those versions and adjust the coverage
data respectively.
.I difffile
needs to be in unified format, i.e. it has to be created using the "\-u" option
of the
.B diff
tool.

Note that lines which are not present in the old version will not be counted
as instrumented, therefore tracefiles resulting from this operation should
not be interpreted individually but together with other tracefiles taken
from the newer version. Also keep in mind that converted coverage data should
only be used for overview purposes as the process itself introduces a loss
of accuracy.

The result of the diff operation will be written to stdout or the tracefile
specified with \-o.

Only one of  \-z, \-c, \-a, \-e, \-r, \-l, \-\-diff or \-\-summary may be
specified at a time.
.RE

.B \-d
.I directory
.br
.B \-\-directory
.I  directory
.br
.RS
Use .da files in
.I directory
instead of kernel.

If you want to work on coverage data for a user space program, use this
option to specify the location where the program was compiled (that's
where the counter files ending with .da will be stored).

Note that you may specify this option more than once.
.RE

.B \-\-exclude
.I pattern
.br
.RS
Exclude source files matching
.IR pattern .

Use this switch if you want to exclude coverage data for a particular set
of source files matching any of the given patterns. Multiple patterns can be
specified by using multiple
.B --exclude
command line switches. The
.I patterns
will be interpreted as shell wildcard patterns (note that they may need to be
escaped accordingly to prevent the shell from expanding them first).

Note: The pattern must be specified to match the
.B absolute
path of each source file.
If you specify a pattern which does not seem to be correctly applied - files that you expected to be excluded still appear in the output - you can look for warning messages in the log file.
.B lcov
will emit a warning for every pattern which is not applied at least once.

Can be combined with the
.B --include
command line switch. If a given file matches both the include pattern and the
exclude pattern, the exclude pattern will take precedence.
.RE

.B \-\-erase\-functions
.I regexp
.br
.RS
Exclude coverage data from lines which fall within a function whose name matches the supplied regexp.  Note that this is a mangled or demangled name, depending on whether the \-\-demangle\-cpp option is used or not.

Note that this option requires that you use a gcc version which is new enough to support function begin/end line reports or that you configure the tool to derive the required dta - see the
.BI derive_function_end_line
discussion in man
.B lcovrc(5).

.RE
.B \-\-substitute
.I regexp_pattern
.br
.RS
Apply Perl regexp
.IR regexp_pattern
to source file names found during processing.  This is useful, for example, when the path name reported by gcov does not match your source layout and the file is not found, or in more complicated environments where the build directory structure does not match the source code layout or the layout in the projects's revision control system.

Use this option in situations where geninfo cannot find the correct
path to source code files of a project. By providing a
.I regexp_pattern
in Perl regular expression format (see man
.BR perlre (1)
), you can instruct geninfo to
remove or change parts of the incorrect source path.
Also see the
.B \-\-resolve\-script
option.

One or more
.I \-\-substitution
patterns and/or a
.I \-\-resolve-script
may be specified.  When multiple paterns are specified, they are applied in the order specifed, substitution patterns first followed by the resolve callback.
The file search order is:
.RS
.IP 1. 3
Look for file name (unmodifed).
.br
If the file exits: return it.
.PP
.IP 2. 3
Apply all substitution patterns in order - the result of the first pattern is used as the input of the second pattern, and so forth.
.br
If a file corresponding to the resulting name exists:  return it.
.PP
.IP 3. 3
Apply the 'resolve' callback ot the final result of pattern substituions.
.br
If a file corresponding to the resulting name exists:  return it.
.PP
.IP 4. 3
Otherwise:  return original (unmodified) file name.
.br
Depending on context, the unresolved file name may or may not result in an error.
.RE

Substitutions are used in multiple contexts by lcov/genhtml/geninfo:
.RS
.IP \-  3
during
.I \-\-capture,
applied to source file names found in gcov-generated coverage data files (see man
.B gcov(1)
).
.PP

.IP \- 3
during
.I \-\-capture,
applied to alternate
.I \-\-build\-dir
paths, when looking for the
.I .gcno
(compile time) data file corresponding to some
.I .gcda
(runtime) data file.
.PP

.IP \- 3
applied to file names found in lcov data files (".info" files) -
.I e.g.,
during lcov data aggregation or HTML and text report generation.
.br
For example, substituted names are used to find source files for
text-based filtering (see the
.I \-\-filter
section, below) and are passed to
.I \-\-version\-script, \-\-annotate\-script,
and
.I \-criteria\-script
callbacks.
.PP

.IP \- 3
applied to file names found in the
.I \-\-diff\-file
passed to genhtml.
.PP
.RE


.B Example:
.br

1. When geninfo reports that it cannot find source file
.br

    /path/to/src/.libs/file.c
.br

while the file is actually located in
.br

    /path/to/src/file.c
.br

use the following parameter:
.br

    \-\-substitute 's#/.libs##g'

This will remove all "/.libs" strings from the path.

2. When geninfo reports that it cannot find source file
.br

    /tmp/build/file.c
.br

while the file is actually located in
.br

    /usr/src/file.c
.br

use the following parameter:
.br

    \-\-substitute 's#/tmp/build#/usr/src#g'
.br

This will change all "/tmp/build" strings in the path to "/usr/src".
.PP

.RE

.B \-\-omit\-lines
.I regexp
.br
.RS
Exclude coverage data from lines whose content matches
.IR regexp .

Use this switch if you want to exclude line and branch coverage data for some particular constructs in your code (e.g., some complicated macro).  Multiple patterns can be
specified by using multiple
.B --omit\-lines
command line switches. The
.I regexp
will be interpreted as perl regular expressions (note that they may need to be
escaped accordingly to prevent the shell from expanding them first).
If you want the pattern to explicitly match from the start or end of the line, your regexp should start and/or end with "^" and/or "$".

Note that the
.B lcovrc
config file setting
.B lcov_excl_line = regexp
is similar to
.B \-\-omit\-lines.
.B \-\-omit\-lines
is useful if there are multiple teams each of which want to exclude certain patterns.
.B \-\-omit\-lines
is additive and can be specified across multiple config files whereas each call to
.B lcov_excl_line
overrides the previous value - and thus teams must coordinate.

.RE

.B \-\-external
.br
.B \-\-no\-external
.br
.RS
Specify whether to capture coverage data for external source files.

External source files are files which are not located in one of the directories
specified by \-\-directory or \-\-base\-directory. Use \-\-external to include
external source files while capturing coverage data or \-\-no\-external to
ignore this data.

Data for external source files is
.B included
by default.

.RE

.B \-\-forget\-test\-names
.br
.RS
If non\-zero, ignore testcase names in .info file -
.I i.e.,
treat all coverage data as if it came from the same testcase.
This may improve performance and reduce memory consumption if user does
not need per-testcase coverage summary in coverage reports.

This option can also be configured permanently using the configuration file
option
.IR forget_testcase_names .

.RE

.B \-\-prune\-tests
.br
.RS
Determine list of unique tracefiles.

Use this option to determine a list of unique tracefiles from the list
specified by
.BR \-\-add\-tracefile .
A tracefile is considered to be unique if it is the only tracefile that:

.RS

.IP 1. 3
contains data for a specific source file
.br
.PP
.IP 2. 3
contains data for a specific test case name
.br
.PP
.IP 3. 3
contains non-zero coverage data for a specific line, function or branch
.br
.PP

.RE

Note that the list of retained files may depend on the order they are processed.  For example, if
.I A
and
.I B
contain identical coverage data, then the first one we see will be retained and the second will be pruned.
The file processing order is nondeterministic when the
.BR \-\-parallel
option is used - implying that the pruned result may differ from one execution to the next in this case.

.BR \-\-prune\-tests must be specified together with
.BR \-\-add\-tracefile .
When specified,
.B lcov
will emit the list of unique files rather than combined tracefile data.
.br

.RE

.B \-\-map\-functions
.br
.RS
List tracefiles with non-zero coverage for each function.
.br

Use this option to determine the list of tracefiles that contain non-zero
coverage data for each function from the list of tracefiles specified by
.BR \-\-add\-tracefile .

This option must be specified together with
.BR \-\-add\-tracefile .
When specified,
.B lcov
will emit the list of functions and associated tracefiles rather than combined tracefile data.
.br

.RE
.B \-\-version\-script
.I script
.br
.RS

Use
.I script
to get a source file's version ID from revision control when
extracting data and to compare version IDs for the purpose of error checking when merging .info files.
.br

See the genhtml man page for more details on the version script.

.br

.RE
.B \-\-resolve\-script
.I script
.br
.RS
Use
.I script
to find the file path for some source file which appears in
an input data file if the file is not found after applying
.I \-\-substitute
patterns and searching the
.I \-\-source\-directory
list.  This option is equivalent to the
.B resolve_script
config file option. See man
.B lcovrc(5)
for details.
.RE

.B \-\-comment
.I comment_string
.br
.RS

Append
.I comment_string
to list of comments emitted into output result file.
This option may be specified multiple times.
Comments are printed at the top of the file, in the order they were specified.

Comments may be useful to document the conditions under which the trace file was
generated:  host, date, environment,
.I etc.

Note that this option has no effect for lcov overations which do not write an
output result file:
.I \-\-list
.I \-\-summary,
.I \-\-prune\-tests,
and
.I \-\-map\-functions.

See the
.B geninfo
man page for a description of the comment format in the result file.

.RE

.B \-e
.I tracefile
.I pattern
.br
.B \-\-extract
.I tracefile
.I pattern
.br
.RS
Extract data from
.IR tracefile .

Use this switch if you want to extract coverage data for only a particular
set of files from a tracefile. Additional command line parameters will be
interpreted as shell wildcard patterns (note that they may need to be
escaped accordingly to prevent the shell from expanding them first).
Every file entry in
.I tracefile
which matches at least one of those patterns will be extracted.

Note: The pattern must be specified to match the
.B absolute
path of each source file.

The result of the extract operation will be written to stdout or the tracefile
specified with \-o.

Only one of  \-z, \-c, \-a, \-e, \-r, \-l, \-\-diff or \-\-summary may be
specified at a time.
.RE

.B \-f
.br
.B \-\-follow
.br
.RS
Follow links when searching for .da files.
.RE

.B \-\-from\-package
.I package
.br
.RS
Use .da files in
.I package
instead of kernel or directory.

Use this option if you have separate machines for build and test and
want to perform the .info file creation on the build machine. See
\-\-to\-package for more information.
.RE

.B \-\-gcov\-tool
.I tool
.br
.RS
Specify the location of the gcov tool.

See the geninfo man page for more details.
.RE

.B \-h
.br
.B \-\-help
.br
.RS
Print a short help text, then exit.
.RE

.B \-\-include
.I pattern
.br
.RS
Include source files matching
.IR pattern .

Use this switch if you want to include coverage data for only a particular set
of source files matching any of the given patterns. Multiple patterns can be
specified by using multiple
.B --include
command line switches. The
.I patterns
will be interpreted as shell wildcard patterns (note that they may need to be
escaped accordingly to prevent the shell from expanding them first).

Note: The pattern must be specified to match the
.B absolute
path of each source file.
.br

If you specify a pattern which does not seem to be correctly applied - files that you expected to be included in the output do not appear - lcov will generate an error message of type 'unused'.  See the \-\-ignore\-errors option for how to make lcov ignore the error or turn it into a warning.
.RE

.B \-\-ignore\-errors
.I errors
.br
.RS
Specify a list of errors after which to continue processing.

Use this option to specify a list of one or more classes of errors after which
lcov should continue processing instead of aborting.
Note that the tool will generate a warning (rather than a fatal error) unless you ignore the error two (or more) times:
.br
.RS
lcov ... --ignore-errors source,source ...
.RE

.I errors
can be a comma\-separated list of the following keywords:

.IP branch: 3
branch ID (2nd field in the .info file 'BRDA' entry) does not follow expected integer sequence.
.PP

.IP callback: 3
Version script error.
.PP

.IP child: 3
child process returned non-zero exit code during
.I \-\-parallel
execution.  This typically indicates that the child encountered an error:  see the log file immediately above this message.
In contrast:  the
.B parallel
error indicates an unexpected/unhandled exception in the child process - not a 'typical' lcov error.
.PP

.IP corrupt: 3
corrupt/unreadable file found.
.PP

.IP count: 3
An excessive number of messages of some class have been reported - subsequent messages of that type will be suppressed.
The limit can be controlled by the 'max_message_count' variable. See man
.B lcovrc(5).
.PP

.IP deprecated: 3
You are using a deprecated option.
This option will be removed in an upcoming release - so you should change your
scripts now.
.PP

.IP empty: 3
the .info data file is empty (e.g., because all the code was 'removed' or excluded.
.PP

.IP excessive: 3
your coverage data contains a suspiciously large 'hit' count which is unlikely
to be correct - possibly indicating a bug in your toolchain.
See the
.I excessive_count_threshold
section in man
.B lcovrc(5)
for details.
.PP

.IP fork: 3
Unable to create child process during
.I \-\-parallel
execution.
.br
If the message is ignored (
.I \-\-ignore\-errors fork
), then genhtml
will wait a brief period and then retry the failed execution.
.br
If you see continued errors, either turn off or reduce parallelism, set a memory limit, or find a larger server to run the task.
.PP

.IP format: 3
unexpected syntax found in .info file.
.PP

.IP gcov: 3
the gcov tool returned with a non\-zero return code.
.PP

.IP graph: 3
the graph file could not be found or is corrupted.
.PP

.IP internal: 3
internal tool issue detected.  Please report this bug along with a testcase.
.PP

.IP mismatch: 3
Inconsistent entries found in trace file:


.RS 3
.IP \(bu 3
branch expression (3rd field in the .info file 'BRDA' entry) of merge data does not match, or
.PP
.IP \(bu 3
function execution count (FNDA:...) but no function declaration (FN:...).
.PP
.RE
.PP

.IP missing: 3
File does not exist or is not readable.
.PP

.IP negative: 3
negative 'hit' count found.

Note that negative counts may be caused by a known GCC bug - see

  https://gcc.gnu.org/bugzilla/show_bug.cgi?id=68080

and try compiling with "-fprofile-update=atomic". You will need to recompile, re-run your tests, and re-capture coverage data.
.PP

.IP package: 3
a required perl package is not installed on your system.  In some cases, it is possible to ignore this message and continue - however, certain features will be disabled in that case.
.PP

.IP parallel: 3
various types of errors related to parallelism -
.I i.e.,
a child process died due to an error.  The corresponding error message appears in the log file immediately before the
.I parallel
error.

If you see an error related to parallel execution that seems invalid, it may be a good idea to remove the \-\-parallel flag and try again.  If removing the flag leads to a different result, please report the issue (along with a testcase) so that the tool can be fixed.
.PP

.IP parent: 3
the parent process exited while child was active during
.I \-\-parallel
execution.  This happens when the parent has encountered a fatal error -
.I e.g.
an error in some other child which was not ignored.  This child cannot continue working without its parent - and so will exit.
.PP

.IP range: 3
Coverage data refers to a line number which is larger than the number of
lines in the source file.  This can be caused by a version mismatch or
by an issue in the
.I gcov
data.
.PP

.IP source: 3
the source code file for a data set could not be found.
.PP

.IP unsupported: 3
the requested feature is not supported for this tool configuration.  For example, function begin/end line range exclusions use some GCOV features that are not available in older GCC releases.
.PP

.IP unused: 3
the include/exclude/erase/omit/substitute pattern did not match any file pathnames.
.PP

.IP usage: 3
unsupported usage detected - e.g. an unsupported option combination.

.PP

.IP utility: 3
a tool called during processing returned an error code (e.g., 'find' encountered an unreadable directory).
.PP

.IP version: 3
revision control IDs of the file which we are trying to merge are not the same - line numbering and other information may be incorrect.
.PP

Also see man
.B lcovrc(5)
for a discussion of the 'max_message_count' parameter which can be used to control the number of warnings which are emitted before all subsequent messages are suppressed.  This can be used to reduce log file volume.


.RE
.BI "\-\-keep\-going "
.RS
Do not stop if error occurs: attempt to generate a result, however flawed.

This command line option corresponds to the
.I stop_on_error [0|1]
lcovrc option.  See man
.B lcovrc(5)
for more details.

.RE
.BI "\-\-preserve "
.RS
Preserve intermediate data files generated by various steps in the tool - e.g., for debugging.  By default, these files are deleted.

.RE
.BI "\-\-filter "
.I filters
.RS
Specify a list of coverpoint filters to apply to input data.
See the genhtml man page for details.


.RE
.BI "\-\-demangle\-cpp " [param]
.RS
Demangle C++ function names.  See the genhtml man page for details.


.RE

.B \-i
.br
.B \-\-initial
.RS
Capture initial zero coverage data - i.e., from the compile-time '.gcno' data
files.
Also see the
.B \-\-all
flag, which tells the tool to capture both compile-time ('.gcno') and runtime
('.gcda') data at the same time.

Run lcov with \-c and this option on the directories containing .bb, .bbg
or .gcno files before running any test case. The result is a "baseline"
coverage data file that contains zero coverage for every instrumented line.
Combine this data file (using lcov \-a) with coverage data files captured
after a test run to ensure that the percentage of total lines covered is
correct even when not all source code files were loaded during the test.

Recommended procedure when capturing data for a test case:

1. create baseline coverage data file
.RS
# lcov \-c \-i \-d appdir \-o app_base.info
.br

.RE
2. perform test
.RS
# appdir/test
.br

.RE
3. create test coverage data file
.RS
# lcov \-c \-d appdir \-o app_test.info
.br

.RE
4. combine baseline and test coverage data
.RS
# lcov \-a app_base.info \-a app_test.info \-o app_total.info
.br
.RE

The above 4 steps are equivalent to
.br
.RS
# lcov \-\-capture \-\-all -o app_total.info \-d appdir
.RE

The combined compile- and runtime data will produce a different result than
capturing runtime data alone if your project contains some compilation units
which are not used in any of your testcase executables or shared libraries -
that is, there are some '.gcno' (compile time) data files that do not
have matching '.gcda' (runtime) data files.
In that case, the runtime-only report will not contain any coverpoints from
the unused files, whereas those coverpoints will appear (with all zero 'hit'
counts) in the combined report.

The
.BR \-\-initial
flag is ignored except in
.BR \-\-capture
mode.  The
.BR \-\-all
flag is ignored if the
.BR \-\-initial
flag is specified.
.RE

.B \-k
.I subdirectory
.br
.B \-\-kernel\-directory
.I subdirectory
.br
.RS
Capture kernel coverage data only from
.IR subdirectory .

Use this option if you don't want to get coverage data for all of the
kernel, but only for specific subdirectories. This option may be specified
more than once.

Note that you may need to specify the full path to the kernel subdirectory
depending on the version of the kernel gcov support.
.RE

.B \-l
.I tracefile
.br
.B \-\-list
.I tracefile
.br
.RS
List the contents of the
.IR tracefile .

Only one of  \-z, \-c, \-a, \-e, \-r, \-l, \-\-diff or \-\-summary may be
specified at a time.
.RE

.B \-\-list\-full\-path
.br
.B \-\-no\-list\-full\-path
.br
.RS
Specify whether to show full paths during list operation.

Use \-\-list\-full\-path to show full paths during list operation
or \-\-no\-list\-full\-path to show shortened paths. Paths are
.B shortened
by default.
.RE

.B \-\-no\-markers
.br
.RS
Use this option if you want to get coverage data without regard to exclusion
markers in the source code file. See
.BR "geninfo " (1)
for details on exclusion markers.
.RE

.B \-\-no\-recursion
.br
.RS
Use this option if you want to get coverage data for the specified directory
only without processing subdirectories.
.RE

.B \-o
.I tracefile
.br
.B \-\-output\-file
.I tracefile
.br
.RS
Write data to
.I tracefile
instead of stdout.

Specify "\-" as a filename to use the standard output.

By convention, lcov\-generated coverage data files are called "tracefiles" and
should have the filename extension ".info".
.RE

.B \-\-path
.I path
.br
.RS
Strip path from filenames when applying diff.

Use this option together with \-\-diff to tell lcov to disregard the specified
initial path component when matching between tracefile and diff filenames.
.RE

.B \-v
.br
.B \-\-verbose
.RS
Increment informational message verbosity.  This is mainly used for script and/or flow debugging - e.g., to figure out which data file are found, where.
Also see the \-\-quiet flag.

Messages are sent to stdout unless there is no output file (i.e., if the coverage data is written to stdout rather than to a file) and to stderr otherwise.

.RE
.B \-q
.br
.B \-\-quiet
.RS
Decrement informational message verbosity.

Decreased verbosity will suppress 'progress' messages for example - while error and warning messages will continue to be printed.

.RE
.B \-\-debug
.RS
Increment 'debug messages' verbosity.  This is useful primarily to developers who want to enhance the lcov tool suite.

.RE

.BI "\-\-parallel "
.I [ integer ]
.br
.BI "\-j "
.I [ integer ]
.RS
Specify parallelism to use during processing (maximum number of forked child processes).  If the optional integer parallelism parameter is zero or is missing, then use to use up the number of cores on the machine.  Default is not to use a single process (no parallelism).
.br
Also see the
.I memory, memory_percentage, max_fork_fails
and
.I fork_fail_timeout
entries in man
.B lcovrc(5).

.RE
.BI "\-\-memory "
.I integer
.RS
Specify the maximum amount of memory to use during parallel processing, in Mb.  Effectively, the process will not fork() if this limit would be exceeded.  Default is 0 (zero) - which means that there is no limit.

This option may be useful if the compute farm environment imposes strict limits on resource utilization such that the job will be killed if it tries to use too many parallel children - but the user does now know a priori what the permissible maximum is.  This option enables the tool to use maximum parallelism - up to the limit imposed by the memory restriction.

The configuration file
.I memory_percentage
option provided another way to set the maximum memory consumption.
See man
.B lcovrc(5)
for details.

.RE

.B \-\-rc
.IR keyword = value
.br
.RS
Override a configuration directive.

Use this option to specify a
.IR keyword = value
statement which overrides the corresponding configuration statement in
the lcovrc configuration file. You can specify this option more than once
to override multiple configuration statements.
See man
.BR lcovrc (5)
for a list of available keywords and their meaning.
.RE

.B \-r
.I tracefile
.I pattern
.br
.B \-\-remove
.I tracefile
.I pattern
.br
.RS
Remove data from
.IR tracefile .

Use this switch if you want to remove coverage data for a particular
set of files from a tracefile. Additional command line parameters will be
interpreted as shell wildcard patterns (note that they may need to be
escaped accordingly to prevent the shell from expanding them first).
Every file entry in
.I tracefile
which matches at least one of those patterns will be removed.

Note: The pattern must be specified to match the
.B absolute
path of each source file.

The result of the remove operation will be written to stdout or the tracefile
specified with \-o.

Only one of  \-z, \-c, \-a, \-e, \-r, \-l, \-\-diff or \-\-summary may be
specified at a time.
.RE

.B \-\-strip
.I depth
.br
.RS
Strip path components when applying diff.

Use this option together with \-\-diff to tell lcov to disregard the specified
number of initial directories when matching tracefile and diff filenames.
.RE

.B \-\-summary
.I tracefile
.br
.RS
Show summary coverage information for the specified tracefile.

Note that you may specify this option more than once.

Only one of  \-z, \-c, \-a, \-e, \-r, \-l, \-\-diff or \-\-summary may be
specified at a time.
.RE

.B \-\-fail-under-lines
.I percentage
.br
.RS
Use this option together with \-\-summary to tell lcov to exit with a status of 1 if the total
line coverage is less than percentage.
.RE

.B \-t
.I testname
.br
.B \-\-test\-name
.I testname
.br
.RS
Specify test name to be stored in the tracefile.

This name identifies a coverage data set when more than one data set is merged
into a combined tracefile (see option \-a).

Valid test names can consist of letters, decimal digits and the underscore
character ("_").
.RE

.B \-\-to\-package
.I package
.br
.RS
Store .da files for later processing.

Use this option if you have separate machines for build and test and
want to perform the .info file creation on the build machine. To do this,
follow these steps:

On the test machine:
.RS
.br
\- run the test
.br
\- run lcov \-c [\-d directory] \-\-to-package
.I file
.br
\- copy
.I file
to the build machine
.RE
.br

On the build machine:
.RS
.br
\- run lcov \-c \-\-from-package
.I file
[\-o and other options]
.RE
.br

This works for both kernel and user space coverage data. Note that you might
have to specify the path to the build directory using \-b with
either \-\-to\-package or \-\-from-package. Note also that the package data
must be converted to a .info file before recompiling the program or it will
become invalid.
.RE

.B \-\-version
.br
.RS
Print version number, then exit.
.RE

.B \-z
.br
.B \-\-zerocounters
.br
.RS
Reset all execution counts to zero.

By default tries to reset kernel execution counts. Use the \-\-directory
option to reset all counters of a user space program.

Only one of  \-z, \-c, \-a, \-e, \-r, \-l, \-\-diff or \-\-summary may be
specified at a time.
.RE

.B \-\-tempdir
.I dirname
.br
.RS
Write temporary and intermediate data to indicated directory.  Default is "/tmp".
.RE

.SH FILES

.I /etc/lcovrc
.RS
The system\-wide configuration file.
.RE

.I ~/.lcovrc
.RS
The per\-user configuration file.
.RE

.SH AUTHOR
Peter Oberparleiter <Peter.Oberparleiter@de.ibm.com>

Henry Cox <henry.cox@mediatek.com>
.RS
Filtering, error management, parallel execution sections.
.RE

.SH SEE ALSO
.BR lcovrc (5),
.BR genhtml (1),
.BR geninfo (1),
.BR genpng (1),
.BR gendesc (1),
.BR gcov (1)
.br

.I \*[lcovurl]
.br
